]> dgit.raspbian.org Git - gnome-shell.git/commitdiff
doc: Update contribution section
authorFlorian Müllner <fmuellner@gnome.org>
Tue, 6 Dec 2022 00:29:58 +0000 (01:29 +0100)
committerFlorian Müllner <fmuellner@gnome.org>
Tue, 6 Dec 2022 00:49:24 +0000 (01:49 +0100)
We no longer *require* a merge request URL in commit messages, we
ban them (since Marge is kind enough to add them for us).

While at it, add a small section on prefixes (~~stolen from~~
inspired by mutter).

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2572>

README.md

index bf0d9aafa60833b095d11498e1a1edaf11d2a6f9..9de841a6544c6da5ff688da4fb107639fd545d60 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,8 +17,11 @@ Please refer to the [*Schedule* wiki page][schedule] to see the supported versio
 To contribute, open merge requests at https://gitlab.gnome.org/GNOME/gnome-shell.
 
 Commit messages should follow the [GNOME commit message
-guidelines](https://wiki.gnome.org/Git/CommitMessages). We require an URL
-to either an issue or a merge request in each commit.
+guidelines](https://wiki.gnome.org/Git/CommitMessages). If a merge request
+fixes an existing issue, it is good practice to append the full issue URL
+to each commit message. Try to always prefix commit subjects with a relevant
+topic, such as `panel:` or `status/network:`, and it's always better to write
+too much in the commit message body than too little.
 
 ## Default branch